<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     * Copyright 2011 Bill Brown<a name="line.2"></a>
<FONT color="green">003</FONT>     *<a name="line.3"></a>
<FONT color="green">004</FONT>     * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<FONT color="green">005</FONT>     * you may not use this file except in compliance with the License.<a name="line.5"></a>
<FONT color="green">006</FONT>     * You may obtain a copy of the License at<a name="line.6"></a>
<FONT color="green">007</FONT>     *<a name="line.7"></a>
<FONT color="green">008</FONT>     * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<FONT color="green">011</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<FONT color="green">012</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<FONT color="green">013</FONT>     * See the License for the specific language governing permissions and<a name="line.13"></a>
<FONT color="green">014</FONT>     * limitations under the License.<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    package com.colorfulsoftware.rss;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    import java.io.Serializable;<a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.LinkedList;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.List;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * The &amp;lt;cloud&gt; element.<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;/p&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * From the &lt;a href="http://cyber.law.harvard.edu/rss/rss.html"&gt;RSS 2.0<a name="line.27"></a>
<FONT color="green">028</FONT>     * specification&lt;/a&gt;...<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;/p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;p&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>     * Allows processes to register with a cloud to be notified of updates to the<a name="line.31"></a>
<FONT color="green">032</FONT>     * channel, implementing a lightweight publish-subscribe protocol for RSS feeds.<a name="line.32"></a>
<FONT color="green">033</FONT>     * More info &amp;lt;a href= &amp;quot;http://cyber.law.harvard.edu/rss/rss.html#<a name="line.33"></a>
<FONT color="green">034</FONT>     * ltcloudgtSubelementOfLtchannelgt&amp;quot; &amp;gt;here&amp;lt;/a&amp;gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * <a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;p&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * &amp;lt;cloud&amp;gt; sub-element of &amp;lt;channel&amp;gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;/p&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * <a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;p&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * &amp;lt;cloud&amp;gt; is an optional sub-element of &amp;lt;channel&amp;gt;.<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;/p&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * <a name="line.44"></a>
<FONT color="green">045</FONT>     * &lt;p&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * It specifies a web service that supports the rssCloud interface which can be<a name="line.46"></a>
<FONT color="green">047</FONT>     * implemented in HTTP-POST, XML-RPC or SOAP 1.1.<a name="line.47"></a>
<FONT color="green">048</FONT>     * &lt;/p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     * <a name="line.49"></a>
<FONT color="green">050</FONT>     * &lt;p&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>     * Its purpose is to allow processes to register with a cloud to be notified of<a name="line.51"></a>
<FONT color="green">052</FONT>     * updates to the channel, implementing a lightweight publish-subscribe protocol<a name="line.52"></a>
<FONT color="green">053</FONT>     * for RSS feeds.<a name="line.53"></a>
<FONT color="green">054</FONT>     * &lt;/p&gt;<a name="line.54"></a>
<FONT color="green">055</FONT>     * <a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     * &amp;lt;cloud domain=&amp;quot;rpc.sys.com&amp;quot; port=&amp;quot;80&amp;quot;<a name="line.57"></a>
<FONT color="green">058</FONT>     * path=&amp;quot;/RPC2&amp;quot; registerProcedure=&amp;quot;myCloud.rssPleaseNotify&amp;quot;<a name="line.58"></a>
<FONT color="green">059</FONT>     * protocol=&amp;quot;xml-rpc&amp;quot; /&amp;gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     * &lt;/p&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     * <a name="line.61"></a>
<FONT color="green">062</FONT>     * &lt;p&gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     * In this example, to request notification on the channel it appears in, you<a name="line.63"></a>
<FONT color="green">064</FONT>     * would send an XML-RPC message to rpc.sys.com on port 80, with a path of<a name="line.64"></a>
<FONT color="green">065</FONT>     * /RPC2. The procedure to call is myCloud.rssPleaseNotify.<a name="line.65"></a>
<FONT color="green">066</FONT>     * &lt;/p&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     * <a name="line.67"></a>
<FONT color="green">068</FONT>     * &lt;p&gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     * A full explanation of this element and the rssCloud interface is &lt;a<a name="line.69"></a>
<FONT color="green">070</FONT>     * href=&amp;quot<a name="line.70"></a>
<FONT color="green">071</FONT>     * ;http://cyber.law.harvard.edu/rss/soapMeetsRss.html#rsscloudInterface&amp;quot;<a name="line.71"></a>
<FONT color="green">072</FONT>     * &amp;gt;here&amp;lt;/a&amp;gt;.<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     * <a name="line.74"></a>
<FONT color="green">075</FONT>     * <a name="line.75"></a>
<FONT color="green">076</FONT>     * @author Bill Brown<a name="line.76"></a>
<FONT color="green">077</FONT>     * <a name="line.77"></a>
<FONT color="green">078</FONT>     */<a name="line.78"></a>
<FONT color="green">079</FONT>    public class Cloud implements Serializable {<a name="line.79"></a>
<FONT color="green">080</FONT>    <a name="line.80"></a>
<FONT color="green">081</FONT>            /**<a name="line.81"></a>
<FONT color="green">082</FONT>             * <a name="line.82"></a>
<FONT color="green">083</FONT>             */<a name="line.83"></a>
<FONT color="green">084</FONT>            private static final long serialVersionUID = 4431999134564899474L;<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            private final List&lt;Attribute&gt; attributes;<a name="line.86"></a>
<FONT color="green">087</FONT>            private final Attribute domain;<a name="line.87"></a>
<FONT color="green">088</FONT>            private final Attribute port;<a name="line.88"></a>
<FONT color="green">089</FONT>            private final Attribute path;<a name="line.89"></a>
<FONT color="green">090</FONT>            private final Attribute registerProcedure;<a name="line.90"></a>
<FONT color="green">091</FONT>            private final Attribute protocol;<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>            Cloud(List&lt;Attribute&gt; attributes) throws RSSpectException {<a name="line.93"></a>
<FONT color="green">094</FONT>                    if (attributes == null) {<a name="line.94"></a>
<FONT color="green">095</FONT>                            throw new RSSpectException(<a name="line.95"></a>
<FONT color="green">096</FONT>                                            "The cloud element requires attributes:  See \"http://cyber.law.harvard.edu/rss/soapMeetsRss.html#rsscloudInterface\".");<a name="line.96"></a>
<FONT color="green">097</FONT>                    } else {<a name="line.97"></a>
<FONT color="green">098</FONT>                            this.attributes = new LinkedList&lt;Attribute&gt;();<a name="line.98"></a>
<FONT color="green">099</FONT>                            for (Attribute attr : attributes) {<a name="line.99"></a>
<FONT color="green">100</FONT>                                    // check for unsupported attribute.<a name="line.100"></a>
<FONT color="green">101</FONT>                                    this.attributes.add(new Attribute(attr.getName(), attr<a name="line.101"></a>
<FONT color="green">102</FONT>                                                    .getValue()));<a name="line.102"></a>
<FONT color="green">103</FONT>                            }<a name="line.103"></a>
<FONT color="green">104</FONT>                    }<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>                    if ((this.domain = getAttribute("domain")) == null) {<a name="line.106"></a>
<FONT color="green">107</FONT>                            throw new RSSpectException(<a name="line.107"></a>
<FONT color="green">108</FONT>                                            "cloud elements MUST have a domain attribute.");<a name="line.108"></a>
<FONT color="green">109</FONT>                    }<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>                    if ((this.port = getAttribute("port")) == null) {<a name="line.111"></a>
<FONT color="green">112</FONT>                            throw new RSSpectException(<a name="line.112"></a>
<FONT color="green">113</FONT>                                            "cloud elements MUST have a port attribute.");<a name="line.113"></a>
<FONT color="green">114</FONT>                    }<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>                    if ((this.path = getAttribute("path")) == null) {<a name="line.116"></a>
<FONT color="green">117</FONT>                            throw new RSSpectException(<a name="line.117"></a>
<FONT color="green">118</FONT>                                            "cloud elements MUST have a path attribute.");<a name="line.118"></a>
<FONT color="green">119</FONT>                    }<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>                    if ((this.registerProcedure = getAttribute("registerProcedure")) == null) {<a name="line.121"></a>
<FONT color="green">122</FONT>                            throw new RSSpectException(<a name="line.122"></a>
<FONT color="green">123</FONT>                                            "cloud elements MUST have a registerProcedure attribute.");<a name="line.123"></a>
<FONT color="green">124</FONT>                    }<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>                    if ((this.protocol = getAttribute("protocol")) == null) {<a name="line.126"></a>
<FONT color="green">127</FONT>                            throw new RSSpectException(<a name="line.127"></a>
<FONT color="green">128</FONT>                                            "cloud elements MUST have a protocol attribute.");<a name="line.128"></a>
<FONT color="green">129</FONT>                    }<a name="line.129"></a>
<FONT color="green">130</FONT>                    if (!getAttribute("protocol").getValue().equals("xml-rpc")<a name="line.130"></a>
<FONT color="green">131</FONT>                                    &amp;&amp; !getAttribute("protocol").getValue().equals("soap")) {<a name="line.131"></a>
<FONT color="green">132</FONT>                            throw new RSSpectException(<a name="line.132"></a>
<FONT color="green">133</FONT>                                            "the cloud's protocol attribute must be 'xml-rpc' or 'soap', case-sensitive.");<a name="line.133"></a>
<FONT color="green">134</FONT>                    }<a name="line.134"></a>
<FONT color="green">135</FONT>            }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>            Cloud(Cloud cloud) {<a name="line.137"></a>
<FONT color="green">138</FONT>                    this.attributes = cloud.getAttributes();<a name="line.138"></a>
<FONT color="green">139</FONT>                    this.domain = cloud.getDomain();<a name="line.139"></a>
<FONT color="green">140</FONT>                    this.port = cloud.getPort();<a name="line.140"></a>
<FONT color="green">141</FONT>                    this.path = cloud.getPath();<a name="line.141"></a>
<FONT color="green">142</FONT>                    this.registerProcedure = cloud.getRegisterProcedure();<a name="line.142"></a>
<FONT color="green">143</FONT>                    this.protocol = cloud.getProtocol();<a name="line.143"></a>
<FONT color="green">144</FONT>            }<a name="line.144"></a>
<FONT color="green">145</FONT>    <a name="line.145"></a>
<FONT color="green">146</FONT>            /**<a name="line.146"></a>
<FONT color="green">147</FONT>             * <a name="line.147"></a>
<FONT color="green">148</FONT>             * @return the cloud attribute list.<a name="line.148"></a>
<FONT color="green">149</FONT>             */<a name="line.149"></a>
<FONT color="green">150</FONT>            public List&lt;Attribute&gt; getAttributes() {<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>                    List&lt;Attribute&gt; attrsCopy = new LinkedList&lt;Attribute&gt;();<a name="line.152"></a>
<FONT color="green">153</FONT>                    for (Attribute attr : this.attributes) {<a name="line.153"></a>
<FONT color="green">154</FONT>                            attrsCopy.add(new Attribute(attr));<a name="line.154"></a>
<FONT color="green">155</FONT>                    }<a name="line.155"></a>
<FONT color="green">156</FONT>                    return attrsCopy;<a name="line.156"></a>
<FONT color="green">157</FONT>            }<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>            /**<a name="line.159"></a>
<FONT color="green">160</FONT>             * @return the domain attribute.<a name="line.160"></a>
<FONT color="green">161</FONT>             */<a name="line.161"></a>
<FONT color="green">162</FONT>            public Attribute getDomain() {<a name="line.162"></a>
<FONT color="green">163</FONT>                    return new Attribute(domain);<a name="line.163"></a>
<FONT color="green">164</FONT>            }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>            /**<a name="line.166"></a>
<FONT color="green">167</FONT>             * @return the port attribute<a name="line.167"></a>
<FONT color="green">168</FONT>             */<a name="line.168"></a>
<FONT color="green">169</FONT>            public Attribute getPort() {<a name="line.169"></a>
<FONT color="green">170</FONT>                    return new Attribute(port);<a name="line.170"></a>
<FONT color="green">171</FONT>            }<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>            /**<a name="line.173"></a>
<FONT color="green">174</FONT>             * @return the path attribute<a name="line.174"></a>
<FONT color="green">175</FONT>             */<a name="line.175"></a>
<FONT color="green">176</FONT>            public Attribute getPath() {<a name="line.176"></a>
<FONT color="green">177</FONT>                    return new Attribute(path);<a name="line.177"></a>
<FONT color="green">178</FONT>            }<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>            /**<a name="line.180"></a>
<FONT color="green">181</FONT>             * @return the registerProcedure attribute.<a name="line.181"></a>
<FONT color="green">182</FONT>             */<a name="line.182"></a>
<FONT color="green">183</FONT>            public Attribute getRegisterProcedure() {<a name="line.183"></a>
<FONT color="green">184</FONT>                    return new Attribute(registerProcedure);<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>            /**<a name="line.187"></a>
<FONT color="green">188</FONT>             * @return the protocol attribute.<a name="line.188"></a>
<FONT color="green">189</FONT>             */<a name="line.189"></a>
<FONT color="green">190</FONT>            public Attribute getProtocol() {<a name="line.190"></a>
<FONT color="green">191</FONT>                    return new Attribute(protocol);<a name="line.191"></a>
<FONT color="green">192</FONT>            }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>            /**<a name="line.194"></a>
<FONT color="green">195</FONT>             * @param attrName<a name="line.195"></a>
<FONT color="green">196</FONT>             *            the name of the attribute to get.<a name="line.196"></a>
<FONT color="green">197</FONT>             * @return the Attribute object if attrName matches or null if not found.<a name="line.197"></a>
<FONT color="green">198</FONT>             */<a name="line.198"></a>
<FONT color="green">199</FONT>            public Attribute getAttribute(String attrName) {<a name="line.199"></a>
<FONT color="green">200</FONT>                    for (Attribute attribute : this.attributes) {<a name="line.200"></a>
<FONT color="green">201</FONT>                            if (attribute.getName().equals(attrName)) {<a name="line.201"></a>
<FONT color="green">202</FONT>                                    return new Attribute(attribute);<a name="line.202"></a>
<FONT color="green">203</FONT>                            }<a name="line.203"></a>
<FONT color="green">204</FONT>                    }<a name="line.204"></a>
<FONT color="green">205</FONT>                    return null;<a name="line.205"></a>
<FONT color="green">206</FONT>            }<a name="line.206"></a>
<FONT color="green">207</FONT>    <a name="line.207"></a>
<FONT color="green">208</FONT>            /**<a name="line.208"></a>
<FONT color="green">209</FONT>             * Shows the contents of the &amp;lt;cloud&gt; element.<a name="line.209"></a>
<FONT color="green">210</FONT>             */<a name="line.210"></a>
<FONT color="green">211</FONT>            @Override<a name="line.211"></a>
<FONT color="green">212</FONT>            public String toString() {<a name="line.212"></a>
<FONT color="green">213</FONT>                    StringBuilder sb = new StringBuilder("&lt;cloud");<a name="line.213"></a>
<FONT color="green">214</FONT>                    for (Attribute attribute : attributes) {<a name="line.214"></a>
<FONT color="green">215</FONT>                            sb.append(attribute);<a name="line.215"></a>
<FONT color="green">216</FONT>                    }<a name="line.216"></a>
<FONT color="green">217</FONT>                    sb.append(" /&gt;");<a name="line.217"></a>
<FONT color="green">218</FONT>                    return sb.toString();<a name="line.218"></a>
<FONT color="green">219</FONT>            }<a name="line.219"></a>
<FONT color="green">220</FONT>            <a name="line.220"></a>
<FONT color="green">221</FONT>            @Override<a name="line.221"></a>
<FONT color="green">222</FONT>            public boolean equals(Object obj) {<a name="line.222"></a>
<FONT color="green">223</FONT>                    if (obj == this) {<a name="line.223"></a>
<FONT color="green">224</FONT>                            return true;<a name="line.224"></a>
<FONT color="green">225</FONT>                    }<a name="line.225"></a>
<FONT color="green">226</FONT>                    if (!(obj instanceof Cloud)) {<a name="line.226"></a>
<FONT color="green">227</FONT>                            return false;<a name="line.227"></a>
<FONT color="green">228</FONT>                    }<a name="line.228"></a>
<FONT color="green">229</FONT>                    return this.toString().equals(obj.toString());<a name="line.229"></a>
<FONT color="green">230</FONT>            }<a name="line.230"></a>
<FONT color="green">231</FONT>            <a name="line.231"></a>
<FONT color="green">232</FONT>            @Override public int hashCode() {<a name="line.232"></a>
<FONT color="green">233</FONT>                    return toString().hashCode();<a name="line.233"></a>
<FONT color="green">234</FONT>            }<a name="line.234"></a>
<FONT color="green">235</FONT>    }<a name="line.235"></a>




























































</PRE>
</BODY>
</HTML>
